home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 5 / Amiga Tools 5.iso / tools / other-tools / readmemaker12 / readmemaker.doc < prev    next >
Encoding:
Text File  |  1996-04-13  |  6.1 KB  |  169 lines
  1.                                     ****************
  2.                                     * Readme Maker *
  3.                                     ****************
  4.  
  5.  
  6.  
  7. Introduction
  8. ------------
  9.  
  10. When you upload file(s) to Aminet you have to write a small
  11. comment of your archive(s). This file, a .readme file is
  12. rather important, it contains the description of your file(s)
  13. and if it is incorrect you may have to upload again.
  14.  
  15. This .readme is rather simple to edit but some persons (me
  16. for example) often forget one or two fields, or mispell the
  17. name so it doesn't match with the archive name. Moreover
  18. I think it is very boring to type a .readme file !
  19.  
  20. So I decided to create Readme Maker. With a nice GUI you
  21. create your .readme files in a very easy way.
  22.  
  23.  
  24. Requirements
  25. ------------
  26.  
  27. In order to use this program you need :
  28.  
  29. - An Amiga and the minimal configuration needed by MUI
  30.  
  31. - MUI 3.3 or higher (available on Aminet : dev/gui).
  32.   I tested Readme Maker with MUI 3.3 but if you have 3.1 or 3.2
  33.   you should try, it may work.
  34.  
  35.  
  36. Installation
  37. ------------
  38.  
  39. Easy ! Juste copy this program where you want...
  40.  
  41.  
  42. Usage
  43. -----
  44.  
  45. When you double-click on the icon you will see a nice GUI. Now, fill
  46. the string gadgets in order to create the .readme file. The
  47. field 'Distribution' is optional, it won't appear if you don't fill it.
  48. The left fields can also be activated by their number on the keyboard
  49. (1 for Description, 2 for Author,...).
  50.  
  51. Readme Maker uses help bubbles, so you can know the purpose of every
  52. gadget in its interface without having to read the documentation file.
  53.  
  54. For the text after the fields you need an external file. Just use your
  55. favourite text editor and use the popup requester to choose your text
  56. once written.
  57.  
  58. The name of the .readme file must be exactly the same as the original
  59. archive. So use the second popup requester to select your archive.
  60. Readme Maker will use this information to build the .readme file's name.
  61. Ex : for Work:Tmp/Essay.lha it will be work:Tmp/Essay.readme.
  62.  
  63. If you want you can add a listing of your archive in your .readme file.
  64. You just have to select the checkmark to do that. The output generated
  65. by this option (lha v) contains useless information like lha's version
  66. so you should use your favourite text editor to remove these useless
  67. lines.
  68.  
  69. Once you've completed these steps you are ready to generate your file.
  70. Click on 'Make Readme' and a console window will appear with the
  71. generated .readme file (you may have to resize the window). If the
  72. window doesn't appear you have a problem like no archive name given or
  73. no possibility to create the file. If you have chosen to add the archive's
  74. listing it won't be displayed in this window : such a listing can be
  75. rather long and could hide the .readme's beginning.
  76.  
  77.  
  78. Disclaimer
  79. ----------
  80.  
  81. Readme Maker has been created and tested on an Amiga 1200 with a
  82. Blizzard 1220/4 expansion card and MUI 3.3. I used MUI 3.3 developer
  83. kit, SAS/C 6.56 and MUI Builder 2.2c to create it.
  84.  
  85. I can't be responsible for ANY damage caused (or seemed to be caused) by
  86. Readme Maker. This program doesn't use dirty hacks so it can't break anything.
  87. You use this program at your own risks.
  88.  
  89. Distribution
  90. ------------
  91.  
  92. Readme Maker is FREEWARE. You can diffuse it freely, as the archive remains
  93. intact (no viruses please). I allow public domain  organisations like Aminet,
  94. Fred Fish or Amiga magazines to include it in their collections and/or CD ROMs.
  95. France Festival Distribution and A.M.I.E. WILL NEVER BE ALLOWED TO DIFFUSE IT.
  96.  
  97. History
  98. -------
  99.  
  100. April 1996              Version 1.00            First Aminet release
  101.  
  102. April 1996              Version 1.1             Partly rewritten code (removed useless
  103.                                                 notifications).
  104.                                                 Added a checkmark to see if
  105.                                                 archive content should be written
  106.                                                 at the end of the file (idea by
  107.                                                 Colin Thompson).
  108.                                                 Added help bubbles.
  109.                                                 The output window is now bigger than
  110.                                                 before, thanks to the great SAS/C
  111.                                                 manual (I should change my glasses ;)).
  112.                                                 Version not released.
  113.  
  114. April 1996              Version 1.2             New interface design, because help
  115.                                                 bubbles messed with the former design.
  116.                                                 Also added keyboard shortcuts. The archive
  117.                                                 now contains advertisment for MUI (I forgot
  118.                                                 it in the previous release).
  119.  
  120.  
  121.  
  122. Author
  123. ------
  124.  
  125. Readme Maker has been created by
  126.  
  127. Franck Aniere
  128. 30 Rue Jean Bouin
  129. 93220 Gagny (France)
  130.  
  131. E-Mail : aniere@univ-mlv.fr
  132. WEB    : http://massena.univ-mlv.fr/~aniere (beware it could become fillmore
  133.          instead of massena)
  134. IRC    : FSA on #amigafr, #amiga, #xfilesfr, #xfiles
  135.  
  136.  
  137. You can contact me for bug reports, enforcer hits (they are welcome, I don't
  138. have a MMU), ideas, suggestions or just to talk :)
  139.  
  140.  
  141. Thanks
  142. ------
  143.  
  144. I would like to thank :
  145.  
  146.  
  147. - Eric Totel, for his GREAT MUI Muilder, for his help and his suggestions. Without him Readme Maker
  148.   would be an ugly text based program.
  149.  
  150. - Stefan Stuntz for MUI (sorry I mispelled your name in the 1.0 version).
  151.  
  152. - Colin Thompson (collin@znet.com), for his suggestions about how to improve Readme Maker.
  153.  
  154. - Some friends of #amigafr, for various reasons
  155.  
  156.  
  157. To do
  158. -----
  159.  
  160. Well, I'd like to use a real MUI window to see the result of the generation but
  161. I will do it only if people want it. Readme Maker will also be able to parse
  162. existing .readme files (idea by Eric Totel). I would like to improve the listing
  163. output but I don't know lha enough to do that (I use lha v, any ideas to remove
  164. 'lha evaluation...' string ?).
  165.  
  166. By the way, next versions will probably be localized...
  167.  
  168. And I will adds thing YOU want in it. Don't be shy, contact me and if
  169. I can add the feature(s) you want I'll do it.